Skip to content

Generate PowerShell docs from code - #935

Draft
Michael Flanakin (flanakin) wants to merge 2 commits into
devfrom
flanakin/dev/ps-docs
Draft

Generate PowerShell docs from code#935
Michael Flanakin (flanakin) wants to merge 2 commits into
devfrom
flanakin/dev/ps-docs

Conversation

@flanakin

Copy link
Copy Markdown
Collaborator

🛠️ Description

Generate PowerShell documentation from code comments.

📋 Checklist

🔬 How did you test this change?

  • 🤏 Lint tests
  • 🤞 PS -WhatIf / az validate
  • 👍 Manually deployed + verified
  • 💪 Unit tests
  • 🙌 Integration tests

🙋‍♀️ Do any of the following that apply?

  • 🚨 This is a breaking change.
  • 🤏 The change is less than 20 lines of code.

📑 Did you update docs/changelog.md?

  • ✅ Updated changelog (required for dev PRs)
  • ➡️ Will add log in a future PR (feature branch PRs only)
  • ❎ Log not needed (small/internal change)

📖 Did you update documentation?

  • ✅ Public docs in docs (required for dev)
  • ✅ Internal dev docs in src (required for dev)
  • ➡️ Will add docs in a future PR (feature branch PRs only)
  • ❎ Docs not needed (small/internal change)

@arthurclares

Copy link
Copy Markdown
Collaborator

Removed assignment and "Needs Review" tag while the PR is still on Draft

@flanakin
Michael Flanakin (flanakin) marked this pull request as ready for review September 3, 2024 10:10
@flanakin
Michael Flanakin (flanakin) requested a review from a team September 3, 2024 10:10
@flanakin Michael Flanakin (flanakin) added Needs: Review 👀 PR that is ready to be reviewed Skill: Documentation Documentation updates Tool: PowerShell PowerShell scripts and automation and removed Skill: Documentation Documentation updates labels Sep 3, 2024
@arthurclares
Arthur Clares (arthurclares) removed their request for review September 5, 2024 23:06
@arthurclares Arthur Clares (arthurclares) removed their assignment Sep 5, 2024
@flanakin
Michael Flanakin (flanakin) marked this pull request as draft April 2, 2025 18:32
@flanakin

Copy link
Copy Markdown
Collaborator Author

🤖 [AI] This comment is stale/no longer actionable — it was about draft-status housekeeping. No action needed; work on this PR is resuming with an updated approach (regenerating docs to match the current MS Learn format instead of the old Jekyll docs).

@microsoft-github-policy-service microsoft-github-policy-service Bot added Needs: Triage 🔍 Untriaged issue needs to be reviewed Needs: Review 👀 PR that is ready to be reviewed and removed Needs: Attention 👋 Issue or PR needs to be reviewed by the author or it will be closed due to no activity labels Aug 26, 2026
…nd reference docs

Adds src/scripts/Build-Documentation.ps1, which regenerates the MS Learn
PowerShell command reference pages under docs-mslearn/toolkit/powershell/
from each command's comment-based help (based on the parsing approach from
the never-merged PR #935, retargeted to the current MS Learn template
instead of the old Jekyll docs/_automation format).

Ports forward the comment-based help improvements from PR #935 where dev's
current help didn't already cover them, and fixes several pre-existing doc
bugs surfaced by generation: wrong/stale parameter names (DataSet vs
Dataset, -ResourceGroup vs -ResourceGroupName), the "how to use the what
{Command}" customer-intent typo, single-quoted vs backtick-wrapped
parameter names, a wrong command name in a customer-intent comment, a
copy-pasted example title, a stale RunHistory return-value shape, and
several commands (Deploy-FinOpsHub, New-FinOpsCostExport) whose docs were
missing parameters added to source since the doc was last hand-written.
Adds the previously-undocumented Add-FinOpsHubScope command's reference
page and lists it (plus other previously-missing commands) in the index
pages.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs: Review 👀 PR that is ready to be reviewed Needs: Triage 🔍 Untriaged issue needs to be reviewed Tool: PowerShell PowerShell scripts and automation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants